getRelationships

Purpose

Retrieves an array of related record IDs. If you supply the optional fieldList parameter is supplied, output only includes values for those fields.

For objects in dedicated tables, you must specify the objName parameter.

HTTP Method

GET

URL

https://app.infiniteblue.com/rest/api/getRelationships

URL Parameters

sessionId

The session ID obtained from the body of the response when calling login.

objName

The object integration name.

id

The record ID.

relName

The relationship integration name.

fieldList

A comma-separated list of field names. If present, only fields from this list are included in the output.

output

Optional parameter specifying the output format, one of: xml (default) or json.

Permissions Required

View permission for the requested object type.

Response

IDs of related records

Example

Output example (XML):

<resp status="ok">
<ids>
<id>314452</id>
<id>128003</id>
</ids>
</resp>

Output example (JSON):

[ 314452, 128003 ]